<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>JsDoc Reference - odr.popup</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
	width: 800px;
}

.header
{
	clear: both;
	background-color: #ccc;
	padding: 8px;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 160px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 190px;
	width: 600px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px; 
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}
		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/Function.html">Function</a></li>
	
	<li><a href="../symbols/odr.html">odr</a></li>
	
	<li><a href="../symbols/odr.Association.html">odr.Association</a></li>
	
	<li><a href="../symbols/odr.Association.listener.html">odr.Association.listener</a></li>
	
	<li><a href="../symbols/odr.Drawable.html">odr.Drawable</a></li>
	
	<li><a href="../symbols/odr.Drawable.listener.html">odr.Drawable.listener</a></li>
	
	<li><a href="../symbols/odr.Endpoint.html">odr.Endpoint</a></li>
	
	<li><a href="../symbols/odr.Endpoint.listener.html">odr.Endpoint.listener</a></li>
	
	<li><a href="../symbols/odr.Handle.html">odr.Handle</a></li>
	
	<li><a href="../symbols/odr.Handle.listener.html">odr.Handle.listener</a></li>
	
	<li><a href="../symbols/odr.Label.html">odr.Label</a></li>
	
	<li><a href="../symbols/odr.Label.listener.html">odr.Label.listener</a></li>
	
	<li><a href="../symbols/odr.Line.html">odr.Line</a></li>
	
	<li><a href="../symbols/odr.Line.listener.html">odr.Line.listener</a></li>
	
	<li><a href="../symbols/odr.Node.html">odr.Node</a></li>
	
	<li><a href="../symbols/odr.Node.listener.html">odr.Node.listener</a></li>
	
	<li><a href="../symbols/odr.popup.html">odr.popup</a></li>
	
	<li><a href="../symbols/odr.Registry.html">odr.Registry</a></li>
	
	<li><a href="../symbols/odr.settings.html">odr.settings</a></li>
	
	<li><a href="../symbols/odr.Shape.html">odr.Shape</a></li>
	
	<li><a href="../symbols/odr.Shape.listener.html">odr.Shape.listener</a></li>
	
	<li><a href="../symbols/String.html">String</a></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Namespace odr.popup
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
				
			
				
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/diagram-core.js.html">diagram-core.js</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class odr.popup.">
				<caption>Namespace Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/odr.popup.html#constructor">odr.popup</a></b>
							</div>
							<div class="description">All popup related functionality is encapsulated within this object</div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class odr.popup.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">odr.popup.<b><a href="../symbols/odr.popup.html#.close">close</a></b>(popupId)
								</div>
								<div class="description">Close the popup</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">odr.popup.<b><a href="../symbols/odr.popup.html#.prepare">prepare</a></b>()
								</div>
								<div class="description">Prepare the popup from beeing shown.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">odr.popup.<b><a href="../symbols/odr.popup.html#.show">show</a></b>(title, text, image, imageAlt, closeable)
								</div>
								<div class="description">Show a popup</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">odr.popup.<b><a href="../symbols/odr.popup.html#.showError">showError</a></b>(errorMessage, closeable)
								</div>
								<div class="description">Show the error popup.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">odr.popup.<b><a href="../symbols/odr.popup.html#.showLoad">showLoad</a></b>()
								</div>
								<div class="description">Show the load popup.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">odr.popup.<b><a href="../symbols/odr.popup.html#.showSave">showSave</a></b>()
								</div>
								<div class="description">Show the save popup.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">odr.popup.<b><a href="../symbols/odr.popup.html#.translate">translate</a></b>()
								</div>
								<div class="description">Translate the temporary values within the popup.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			
<!-- ============================== events summary ======================== -->
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Namespace Detail
				</div>
				
				<div class="fixedFont">
						<b>odr.popup</b>
				</div>
				
				<div class="description">
					All popup related functionality is encapsulated within this object
					
				</div>
				
				
				
				
					
					
					
					
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name=".close"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">odr.popup.</span><b>close</b>(popupId)
					
					</div>
					<div class="description">
						Close the popup
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>popupId</b>
									<i>Optional</i>
								</dt>
								<dd>The id which you retrieved when you opened the popup. By supplying this id you can
ensure that the popup will only be closed when it was the last one which was opened. When you don't supply an id,
then the popup will be closed what so ever.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".prepare"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">odr.popup.</span><b>prepare</b>()
					
					</div>
					<div class="description">
						Prepare the popup from beeing shown. This method is called during initialization of the visualization. It uses
temporary button labels.
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name=".show"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{Number}</span>
					<span class="light">odr.popup.</span><b>show</b>(title, text, image, imageAlt, closeable)
					
					</div>
					<div class="description">
						Show a popup
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>title</b>
									
								</dt>
								<dd>The title of the popup</dd>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>text</b>
									
								</dt>
								<dd>The message that will be presented within the popup</dd>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>image</b>
									
								</dt>
								<dd>The url to the image</dd>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>imageAlt</b>
									
								</dt>
								<dd>The alternative image text</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>closeable</b>
									<i>Optional</i>
								</dt>
								<dd>Whether this dialog is closeable. Default is true</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Number}</span> A popupId number that can be supplied to <a href="../symbols/odr.popup.html#.close">odr.popup.close</a> to close the popup.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".showError"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{Number}</span>
					<span class="light">odr.popup.</span><b>showError</b>(errorMessage, closeable)
					
					</div>
					<div class="description">
						Show the error popup. This will use the default translations and icon for the error dialog.

The error message won't be presented directly to the user but instead will be placed on the console.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>errorMessage</b>
									<i>Optional</i>
								</dt>
								<dd>A message that will be logged on the JavaScript console.</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>closeable</b>
									<i>Optional</i>
								</dt>
								<dd>Whether the user should get the possibility to close the dialog. Default: false</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Number}</span> A popupId number that can be supplied to <a href="../symbols/odr.popup.html#.close">odr.popup.close</a> to close the popup.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".showLoad"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{Number}</span>
					<span class="light">odr.popup.</span><b>showLoad</b>()
					
					</div>
					<div class="description">
						Show the load popup. This will use the default translations and icon for the loading dialog.
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Number}</span> A popupId number that can be supplied to <a href="../symbols/odr.popup.html#.close">odr.popup.close</a> to close the popup.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".showSave"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{Number}</span>
					<span class="light">odr.popup.</span><b>showSave</b>()
					
					</div>
					<div class="description">
						Show the save popup. This will use the default translations and icon for the save dialog.
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Number}</span> A popupId number that can be supplied to <a href="../symbols/odr.popup.html#.close">odr.popup.close</a> to close the popup.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".translate"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">odr.popup.</span><b>translate</b>()
					
					</div>
					<div class="description">
						Translate the temporary values within the popup. This method will also be called during initialization but after
the translation has been loaded from the server
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					
				
			
			
<!-- ============================== event details ========================= -->		
			
			
			<hr />
		</div>

		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			
			Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Sun Dec 19 2010 14:46:05 GMT+0100 (CET)
		</div>
	</body>
</html>
